<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>&quot;core/chords&quot; | @magenta/music</title>
	<meta name="description" content="">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">@magenta/music</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-only-exported" />
							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../globals.html">Globals</a>
				</li>
				<li>
					<a href="_core_chords_.html">&quot;core/chords&quot;</a>
				</li>
			</ul>
			<h1>External module &quot;core/chords&quot;</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel tsd-comment">
				<div class="tsd-comment tsd-typography">
					<div class="lead">
						<p>Module containing functionality for encoding chord symbol strings as tensors
						for input to models, typically as a conditioning variable.</p>
					</div>
					<dl class="tsd-comment-tags">
						<dt>license</dt>
						<dd><p>Copyright 2018 Google Inc. All Rights Reserved.</p>
							<p>Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
								you may not use this file except in compliance with the License.
							You may obtain a copy of the License at</p>
							<p>   <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></p>
							<p>Unless required by applicable law or agreed to in writing, software
								distributed under the License is distributed on an &quot;AS IS&quot; BASIS,
								WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
								See the License for the specific language governing permissions and
							limitations under the License.</p>
						</dd>
					</dl>
				</div>
			</section>
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Enumerations</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-enum tsd-parent-kind-external-module"><a href="../enums/_core_chords_.chordquality.html" class="tsd-kind-icon">Chord<wbr>Quality</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Classes</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/_core_chords_.chordencoder.html" class="tsd-kind-icon">Chord<wbr>Encoder</a></li>
								<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/_core_chords_.chordencodingexception.html" class="tsd-kind-icon">Chord<wbr>Encoding<wbr>Exception</a></li>
								<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/_core_chords_.chordsymbolexception.html" class="tsd-kind-icon">Chord<wbr>Symbol<wbr>Exception</a></li>
								<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/_core_chords_.chordsymbols.html" class="tsd-kind-icon">Chord<wbr>Symbols</a></li>
								<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/_core_chords_.majorminorchordencoder.html" class="tsd-kind-icon">Major<wbr>Minor<wbr>Chord<wbr>Encoder</a></li>
								<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/_core_chords_.pitchchordencoder.html" class="tsd-kind-icon">Pitch<wbr>Chord<wbr>Encoder</a></li>
								<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/_core_chords_.triadchordencoder.html" class="tsd-kind-icon">Triad<wbr>Chord<wbr>Encoder</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Type aliases</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_core_chords_.html#chordencodertype" class="tsd-kind-icon">Chord<wbr>Encoder<wbr>Type</a></li>
							</ul>
						</section>
						<section class="tsd-index-section tsd-is-not-exported">
							<h3>Variables</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="_core_chords_.html#chord_quality_intervals" class="tsd-kind-icon">CHORD_<wbr>QUALITY_<wbr>INTERVALS</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Functions</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_core_chords_.html#chordencoderfromtype" class="tsd-kind-icon">chord<wbr>Encoder<wbr>From<wbr>Type</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Type aliases</h2>
				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
					<a name="chordencodertype" class="tsd-anchor"></a>
					<h3>Chord<wbr>Encoder<wbr>Type</h3>
					<div class="tsd-signature tsd-kind-icon">Chord<wbr>Encoder<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"MajorMinorChordEncoder"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"TriadChordEncoder"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"PitchChordEncoder"</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/tensorflow/magenta-js/tree/master/music/src/core/chords.ts#L144">core/chords.ts:144</a></li>
						</ul>
					</aside>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
				<h2>Variables</h2>
				<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
					<a name="chord_quality_intervals" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagConst">Const</span> CHORD_<wbr>QUALITY_<wbr>INTERVALS</h3>
					<div class="tsd-signature tsd-kind-icon">CHORD_<wbr>QUALITY_<wbr>INTERVALS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> =&nbsp;[[&#x27;1P&#x27;, &#x27;3M&#x27;, &#x27;5P&#x27;],  // major[&#x27;1P&#x27;, &#x27;3m&#x27;, &#x27;5P&#x27;],  // minor[&#x27;1P&#x27;, &#x27;3M&#x27;, &#x27;5A&#x27;],  // augmented[&#x27;1P&#x27;, &#x27;3m&#x27;, &#x27;5d&#x27;],  // diminished]</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/tensorflow/magenta-js/tree/master/music/src/core/chords.ts#L28">core/chords.ts:28</a></li>
						</ul>
					</aside>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Functions</h2>
				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module">
					<a name="chordencoderfromtype" class="tsd-anchor"></a>
					<h3>chord<wbr>Encoder<wbr>From<wbr>Type</h3>
					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
						<li class="tsd-signature tsd-kind-icon">chord<wbr>Encoder<wbr>From<wbr>Type<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="_core_chords_.html#chordencodertype" class="tsd-signature-type">ChordEncoderType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/_core_chords_.majorminorchordencoder.html" class="tsd-signature-type">MajorMinorChordEncoder</a><span class="tsd-signature-symbol"> | </span><a href="../classes/_core_chords_.triadchordencoder.html" class="tsd-signature-type">TriadChordEncoder</a><span class="tsd-signature-symbol"> | </span><a href="../classes/_core_chords_.pitchchordencoder.html" class="tsd-signature-type">PitchChordEncoder</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/tensorflow/magenta-js/tree/master/music/src/core/chords.ts#L153">core/chords.ts:153</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Creates a <code>ChordEncoder</code> based on the given <code>ChordEncoderType</code>.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>type: <a href="_core_chords_.html#chordencodertype" class="tsd-signature-type">ChordEncoderType</a></h5>
									<div class="tsd-comment tsd-typography">
										<p>Specifies the <code>ChordEncoder</code> to create.</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="../classes/_core_chords_.majorminorchordencoder.html" class="tsd-signature-type">MajorMinorChordEncoder</a>
								<span class="tsd-signature-symbol"> | </span>
								<a href="../classes/_core_chords_.triadchordencoder.html" class="tsd-signature-type">TriadChordEncoder</a>
								<span class="tsd-signature-symbol"> | </span>
								<a href="../classes/_core_chords_.pitchchordencoder.html" class="tsd-signature-type">PitchChordEncoder</a>
							</h4>
							<p>A new <code>ChordEncoder</code> object based on <code>type</code>.</p>
						</li>
					</ul>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals  ">
						<a href="../globals.html"><em>Globals</em></a>
					</li>
					<li class="current tsd-kind-external-module">
						<a href="_core_chords_.html">"core/chords"</a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
					<li class=" tsd-kind-enum tsd-parent-kind-external-module">
						<a href="../enums/_core_chords_.chordquality.html" class="tsd-kind-icon">Chord<wbr>Quality</a>
					</li>
					<li class=" tsd-kind-class tsd-parent-kind-external-module">
						<a href="../classes/_core_chords_.chordencoder.html" class="tsd-kind-icon">Chord<wbr>Encoder</a>
					</li>
					<li class=" tsd-kind-class tsd-parent-kind-external-module">
						<a href="../classes/_core_chords_.chordencodingexception.html" class="tsd-kind-icon">Chord<wbr>Encoding<wbr>Exception</a>
					</li>
					<li class=" tsd-kind-class tsd-parent-kind-external-module">
						<a href="../classes/_core_chords_.chordsymbolexception.html" class="tsd-kind-icon">Chord<wbr>Symbol<wbr>Exception</a>
					</li>
					<li class=" tsd-kind-class tsd-parent-kind-external-module">
						<a href="../classes/_core_chords_.chordsymbols.html" class="tsd-kind-icon">Chord<wbr>Symbols</a>
					</li>
					<li class=" tsd-kind-class tsd-parent-kind-external-module">
						<a href="../classes/_core_chords_.majorminorchordencoder.html" class="tsd-kind-icon">Major<wbr>Minor<wbr>Chord<wbr>Encoder</a>
					</li>
					<li class=" tsd-kind-class tsd-parent-kind-external-module">
						<a href="../classes/_core_chords_.pitchchordencoder.html" class="tsd-kind-icon">Pitch<wbr>Chord<wbr>Encoder</a>
					</li>
					<li class=" tsd-kind-class tsd-parent-kind-external-module">
						<a href="../classes/_core_chords_.triadchordencoder.html" class="tsd-kind-icon">Triad<wbr>Chord<wbr>Encoder</a>
					</li>
					<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
						<a href="_core_chords_.html#chordencodertype" class="tsd-kind-icon">Chord<wbr>Encoder<wbr>Type</a>
					</li>
					<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
						<a href="_core_chords_.html#chord_quality_intervals" class="tsd-kind-icon">CHORD_<wbr>QUALITY_<wbr>INTERVALS</a>
					</li>
					<li class=" tsd-kind-function tsd-parent-kind-external-module">
						<a href="_core_chords_.html#chordencoderfromtype" class="tsd-kind-icon">chord<wbr>Encoder<wbr>From<wbr>Type</a>
					</li>
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>